/*
 * xlog.h
 *
 * PostgreSQL 写前日志管理器
 *
 * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/access/xlog.h
 */
#ifndef XLOG_H
#define XLOG_H

#include "access/xlogdefs.h"
#include "access/xlogreader.h"
#include "datatype/timestamp.h"
#include "lib/stringinfo.h"
#include "nodes/pg_list.h"


/* 同步方法 */
#define SYNC_METHOD_FSYNC		0
#define SYNC_METHOD_FDATASYNC	1
#define SYNC_METHOD_OPEN		2	/* 针对 O_SYNC */
#define SYNC_METHOD_FSYNC_WRITETHROUGH	3
#define SYNC_METHOD_OPEN_DSYNC	4	/* 针对 O_DSYNC */
extern PGDLLIMPORT int sync_method;

extern PGDLLIMPORT XLogRecPtr ProcLastRecPtr;
extern PGDLLIMPORT XLogRecPtr XactLastRecEnd;
extern PGDLLIMPORT XLogRecPtr XactLastCommitEnd;

/* 这些变量是与 XLOG 相关的 GUC 参数 */
extern PGDLLIMPORT int wal_segment_size;
extern PGDLLIMPORT int min_wal_size_mb;
extern PGDLLIMPORT int max_wal_size_mb;
extern PGDLLIMPORT int wal_keep_size_mb;
extern PGDLLIMPORT int max_slot_wal_keep_size_mb;
extern PGDLLIMPORT int XLOGbuffers;
extern PGDLLIMPORT int XLogArchiveTimeout;
extern PGDLLIMPORT int wal_retrieve_retry_interval;
extern PGDLLIMPORT char *XLogArchiveCommand;
extern PGDLLIMPORT bool EnableHotStandby;
extern PGDLLIMPORT bool fullPageWrites;
extern PGDLLIMPORT bool wal_log_hints;
extern PGDLLIMPORT int wal_compression;
extern PGDLLIMPORT bool wal_init_zero;
extern PGDLLIMPORT bool wal_recycle;
extern PGDLLIMPORT bool *wal_consistency_checking;
extern PGDLLIMPORT char *wal_consistency_checking_string;
extern PGDLLIMPORT bool log_checkpoints;
extern PGDLLIMPORT bool track_wal_io_timing;
extern PGDLLIMPORT int wal_decode_buffer_size;

extern PGDLLIMPORT int CheckPointSegments;

/* 存档模式 */
typedef enum ArchiveMode
{
	ARCHIVE_MODE_OFF = 0,		/* disabled */
	ARCHIVE_MODE_ON,			/* 在服务器正常运行时启用 */
	ARCHIVE_MODE_ALWAYS			/* 始终启用（即使在恢复期间） */
} ArchiveMode;
extern PGDLLIMPORT int XLogArchiveMode;

/* WAL 级别 */
typedef enum WalLevel
{
	WAL_LEVEL_MINIMAL = 0,
	WAL_LEVEL_REPLICA,
	WAL_LEVEL_LOGICAL
} WalLevel;

/* WAL 的压缩算法 */
typedef enum WalCompression
{
	WAL_COMPRESSION_NONE = 0,
	WAL_COMPRESSION_PGLZ,
	WAL_COMPRESSION_LZ4,
	WAL_COMPRESSION_ZSTD
} WalCompression;

/* 恢复状态 */
typedef enum RecoveryState
{
	RECOVERY_STATE_CRASH = 0,	/* 崩溃恢复 */
	RECOVERY_STATE_ARCHIVE,		/* 存档恢复 */
	RECOVERY_STATE_DONE			/* 当前在生产中 */
} RecoveryState;

extern PGDLLIMPORT int wal_level;

/* 是否启用了 WAL 存档（始终或仅在服务器正常运行时）？ */
#define XLogArchivingActive() \
	(AssertMacro(XLogArchiveMode == ARCHIVE_MODE_OFF || wal_level >= WAL_LEVEL_REPLICA), XLogArchiveMode > ARCHIVE_MODE_OFF)
/* 是否始终启用了 WAL 存档（即使在恢复期间）？ */
#define XLogArchivingAlways() \
	(AssertMacro(XLogArchiveMode == ARCHIVE_MODE_OFF || wal_level >= WAL_LEVEL_REPLICA), XLogArchiveMode == ARCHIVE_MODE_ALWAYS)

/*
 * 存档或日志传输是否需要 WAL 记录，或者如果我们在提交之前使用 fsync() 对数据进行同步，
 * 是否可以跳过 WAL 记录？
 */
#define XLogIsNeeded() (wal_level >= WAL_LEVEL_REPLICA)

/*
 * 更新提示位时是否需要完整数据页的图像？
 *
 * 通常情况下，我们不会 WAL 记录提示位更新，但如果启用了校验和，
 * 我们必须保护它们以防止页撕裂写入。当您只在页面上设置
 * 单个位时，无论哪些位的组合写入磁盘，仍然是一致的，但校验和将不匹配。
 * 如果 wal_log_hints=on 强制 WAL 记录它们。
 */
#define XLogHintBitIsNeeded() (DataChecksumsEnabled() || wal_log_hints)

/* 我们是否需要 WAL 记录仅在热备用和逻辑复制中需要的信息？ */
#define XLogStandbyInfoActive() (wal_level >= WAL_LEVEL_REPLICA)

/* 我们需要为仅逻辑复制所需的信息进行WAL日志记录吗？ */
#define XLogLogicalInfoActive() (wal_level >= WAL_LEVEL_LOGICAL)

#ifdef WAL_DEBUG
extern PGDLLIMPORT bool XLOG_DEBUG;
#endif

/*
 * 检查点的可或请求标志位。 "原因"位仅用于日志记录目的。
 * 注意：标志必须定义为可以合理地将来自不同请求者的请求标志进行OR操作。
 */

/* 这些直接影响CreateCheckPoint及其子过程的行为 */
#define CHECKPOINT_IS_SHUTDOWN	0x0001	/* 检查点用于关闭 */
#define CHECKPOINT_END_OF_RECOVERY	0x0002	/* 类似于关闭检查点，但在WAL恢复结束时发出 */
#define CHECKPOINT_IMMEDIATE	0x0004	/* 无延迟执行 */
#define CHECKPOINT_FORCE		0x0008	/* 即使没有活动也强制执行 */
#define CHECKPOINT_FLUSH_ALL	0x0010	/* 刷新所有页面，包括属于未记录表的页面 */
/* 这些对RequestCheckpoint很重要 */
#define CHECKPOINT_WAIT			0x0020	/* 等待完成 */
#define CHECKPOINT_REQUESTED	0x0040	/* 已发出检查点请求 */
/* 这些指示检查点请求的原因 */
#define CHECKPOINT_CAUSE_XLOG	0x0080	/* XLOG消费 */
#define CHECKPOINT_CAUSE_TIME	0x0100	/* 已经过的时间 */

/*
 * 正在插入的记录的标志位，通过XLogSetRecordFlags()设置。
 */
#define XLOG_INCLUDE_ORIGIN		0x01	/* 包括复制源 */
#define XLOG_MARK_UNIMPORTANT	0x02	/* 对耐久性不重要的记录 */


/* 检查点统计信息 */
typedef struct CheckpointStatsData
{
	TimestampTz ckpt_start_t;	/* 检查点开始 */
	TimestampTz ckpt_write_t;	/* 开始刷新缓冲区 */
	TimestampTz ckpt_sync_t;	/* 开始fsyncs */
	TimestampTz ckpt_sync_end_t;	/* fsyncs结束 */
	TimestampTz ckpt_end_t;		/* 检查点结束 */

	int			ckpt_bufs_written;	/* 写入的缓冲区数量 */

	int			ckpt_segs_added;	/* 创建的新xlog段数量 */
	int			ckpt_segs_removed;	/* 删除的xlog段数量 */
	int			ckpt_segs_recycled; /* 回收的xlog段数量 */

	int			ckpt_sync_rels; /* 已同步的关系数量 */
	uint64		ckpt_longest_sync;	/* 一个关系的最长同步时间 */
	uint64		ckpt_agg_sync_time; /* 所有单独同步时间的总和，并不一定等于整个同步阶段的总经过时间。 */
} CheckpointStatsData;

extern PGDLLIMPORT CheckpointStatsData CheckpointStats;

/*
 * GetWALAvailability 返回码
 */
typedef enum WALAvailability
{
	WALAVAIL_INVALID_LSN,		/* 参数错误 */
	WALAVAIL_RESERVED,			/* WAL 段在 max_wal_size 之内 */
	WALAVAIL_EXTENDED,			/* WAL 段被一个槽或 wal_keep_size 保留 */
	WALAVAIL_UNRESERVED,		/* 不再保留，但尚未移除 */
	WALAVAIL_REMOVED			/* WAL 段已经被移除 */
} WALAvailability;

struct XLogRecData;

extern XLogRecPtr XLogInsertRecord(struct XLogRecData *rdata,
								   XLogRecPtr fpw_lsn,
								   uint8 flags,
								   int num_fpi,
								   bool topxid_included);
extern void XLogFlush(XLogRecPtr RecPtr);
extern bool XLogBackgroundFlush(void);
extern bool XLogNeedsFlush(XLogRecPtr RecPtr);
extern int	XLogFileInit(XLogSegNo segno, TimeLineID tli);
extern int	XLogFileOpen(XLogSegNo segno, TimeLineID tli);

extern void CheckXLogRemoved(XLogSegNo segno, TimeLineID tli);
extern XLogSegNo XLogGetLastRemovedSegno(void);
extern void XLogSetAsyncXactLSN(XLogRecPtr record);
extern void XLogSetReplicationSlotMinimumLSN(XLogRecPtr lsn);

extern void xlog_redo(XLogReaderState *record);
extern void xlog_desc(StringInfo buf, XLogReaderState *record);
extern const char *xlog_identify(uint8 info);

extern void issue_xlog_fsync(int fd, XLogSegNo segno, TimeLineID tli);

extern bool RecoveryInProgress(void);
extern RecoveryState GetRecoveryState(void);
extern bool XLogInsertAllowed(void);
extern XLogRecPtr GetXLogInsertRecPtr(void);
extern XLogRecPtr GetXLogWriteRecPtr(void);

#ifdef FDD
//保存配置文件中encryption_key_command记录外部加密密码文件
extern char *g_fdbEncryptionKeyCommand;
extern char  *g_tdepass ;
//初始化 TDE 的秘钥
extern void fdb_checkAndInitEncrypt(void);
//更新用于加密TDE密钥的外部主密钥  
extern void fdb_change_tde_passwd(char *old_pass, char *new_pass);
//用于BootstrapModeMain进程检测是否开启TDE，并且将相关加密密钥赋值到ControlFile中保存  
extern void fdb_BootstrapModeMain_set_tde(void);
#endif //FDD
extern uint64 GetSystemIdentifier(void);
extern char *GetMockAuthenticationNonce(void);
extern bool DataChecksumsEnabled(void);
extern XLogRecPtr GetFakeLSNForUnloggedRel(void);
extern Size XLOGShmemSize(void);
extern void XLOGShmemInit(void);
extern void BootStrapXLOG(void);
extern void LocalProcessControlFile(bool reset);
extern void StartupXLOG(void);
extern void ShutdownXLOG(int code, Datum arg);
extern void CreateCheckPoint(int flags);
extern bool CreateRestartPoint(int flags);
extern WALAvailability GetWALAvailability(XLogRecPtr targetLSN);
extern void XLogPutNextOid(Oid nextOid);
extern XLogRecPtr XLogRestorePoint(const char *rpName);
extern void UpdateFullPageWrites(void);
extern void GetFullPageWriteInfo(XLogRecPtr *RedoRecPtr_p, bool *doPageWrites_p);
extern XLogRecPtr GetRedoRecPtr(void);
extern XLogRecPtr GetInsertRecPtr(void);
extern XLogRecPtr GetFlushRecPtr(TimeLineID *insertTLI);
extern TimeLineID GetWALInsertionTimeLine(void);
extern XLogRecPtr GetLastImportantRecPtr(void);

extern void SetWalWriterSleeping(bool sleeping);

extern void assign_max_wal_size(int newval, void *extra);
extern void assign_checkpoint_completion_target(double newval, void *extra);

/*
 * xlogrecovery.c 使用的例程，在恢复期间回调 xlog.c。
 */
extern void RemoveNonParentXlogFiles(XLogRecPtr switchpoint, TimeLineID newTLI);
extern bool XLogCheckpointNeeded(XLogSegNo new_segno);
extern void SwitchIntoArchiveRecovery(XLogRecPtr EndRecPtr, TimeLineID replayTLI);
extern void ReachedEndOfBackup(XLogRecPtr EndRecPtr, TimeLineID tli);
extern void SetInstallXLogFileSegmentActive(void);
extern bool IsInstallXLogFileSegmentActive(void);
extern void XLogShutdownWalRcv(void);

/*
 * 启动、停止和获取基础备份状态的例程。
 */

/*
 * 基本备份的会话级状态
 *
 * 这与共享内存状态并行使用，用于控制给定会话的基本备份函数的并行执行，
 * 无论是专用于复制的后端，还是连接到数据库的正常后端。
 * 会话级状态的更新与共享内存计数器同时发生，以保持备份运行的一致全局和本地状态。
 */
typedef enum SessionBackupState
{
	SESSION_BACKUP_NONE,
	SESSION_BACKUP_RUNNING,
} SessionBackupState;

extern XLogRecPtr do_pg_backup_start(const char *backupidstr, bool fast,
									 TimeLineID *starttli_p, StringInfo labelfile,
									 List **tablespaces, StringInfo tblspcmapfile);
extern XLogRecPtr do_pg_backup_stop(char *labelfile, bool waitforarchive,
									TimeLineID *stoptli_p);
extern void do_pg_abort_backup(int code, Datum arg);
extern void register_persistent_abort_backup_handler(void);
extern SessionBackupState get_backup_status(void);

/* 文件路径名称（均相对于 $PGDATA） */
#define RECOVERY_SIGNAL_FILE	"recovery.signal"
#define STANDBY_SIGNAL_FILE		"standby.signal"
#define BACKUP_LABEL_FILE		"backup_label"
#define BACKUP_LABEL_OLD		"backup_label.old"

#define TABLESPACE_MAP			"tablespace_map"
#define TABLESPACE_MAP_OLD		"tablespace_map.old"

/* 用于发送提升为主的信号的文件 */
#define PROMOTE_SIGNAL_FILE		"promote"

#endif							/* XLOG_H */
